Skip to content

Add update-discussion documentation to safe-outputs reference #8089

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
mnkiefer merged 3 commits into from
Dec 29, 2025
Merged

Add update-discussion documentation to safe-outputs reference #8089

mnkiefer merged 3 commits into from
Dec 29, 2025
+23 −2

Conversation

Copy link
Contributor

Copilot AI commented Dec 29, 2025 •
edited
Loading

The update-discussion safe output type was missing from the user-facing documentation despite being fully implemented and tested.

Changes

  • Added table entry in "Available Safe Output Types" with anchor link to detailed section
  • Added documentation section after "Close Discussion" covering:
    • Field enablement pattern (title:, body:, labels:)
    • Label restriction via allowed-labels
    • Target options (triggering, *, or specific number)
    • Cross-repository support via target-repo

Example

safe-outputs:
  update-discussion:
    title:                    # enable title updates
    body:                     # enable body updates
    labels:                   # enable label updates
    allowed-labels: [bug, idea] # restrict to specific labels
    max: 1                    # max updates (default: 1)
    target: "*"               # "triggering" (default), "*", or number
    target-repo: "owner/repo" # cross-repository

Documentation follows the established pattern used for update-issue and update-pull-request.

Original prompt

Udate docs safe output with update-discussion.

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Copilot AI changed the title [WIP] Update documentation for safe output with update-discussion Add update-discussion documentation to safe-outputs reference Dec 29, 2025
Copilot AI requested a review from mnkiefer December 29, 2025 15:13
@mnkiefer mnkiefer marked this pull request as ready for review December 29, 2025 15:16
@mnkiefer
Copy link
Contributor

mnkiefer commented Dec 29, 2025

@copilot: Make sure documentation follow actual implementation.

Copy link
Contributor Author

Copilot AI commented Dec 29, 2025

@copilot: Make sure documentation follow actual implementation.

I've verified the documentation against the actual implementation in pkg/workflow/update_discussion.go and actions/setup/js/update_discussion.cjs. The documentation accurately reflects all supported fields:

  • Field enablement pattern (key existence for title:, body:, labels:)
  • Label restriction via allowed-labels with implicit label enablement
  • Inherited fields from UpdateEntityConfig (max, target, target-repo, github-token)
  • Default values and behaviors

The documentation follows the same pattern as update-issue and matches the schema in frontmatter-full.md. All features are correctly documented.

@mnkiefer mnkiefer merged commit 866a62c into main Dec 29, 2025
86 of 87 checks passed
@mnkiefer mnkiefer deleted the copilot/update-docs-safe-output branch December 29, 2025 15:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mnkiefer mnkiefer Awaiting requested review from mnkiefer

Assignees

@mnkiefer mnkiefer

Copilot code review Copilot

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@mnkiefer